System and method for detecting a connection leak in a  j2ee connector architecture

ABSTRACT

A connector architecture implementation that is J2EE compliant and provides improved connection management capabilities. The connector architecture implementation provides a connector leak detection mechanism that detects connection leaks both automatically and manually. The connector architecture implementation pre-configures and manages the growth and reduction of a connection pool. The connector architecture implementation may be pre-configured by pre-populating the connection pool. Connection pool growth may be managed by generating connections in response to connection requests. A connection pool may also be configured to reduce the number of connections in the pool. The number of connections may be reduced if the connection demand decreases. Password credentials allowing access to services are used to provide additional connection management.

CLAIM OF PRIORITY

This application is a divisional of pending U.S. patent application Ser. No. 10/248,744 entitled “J2EE CONNECTOR ARCHITECTURE,” by Deborah C. June, et al., filed Feb. 13, 2003, which claims the benefit of U.S. Provisional Patent Application No. 60/406,745 filed Aug. 29, 2002, which applications are incorporated herein.

CROSS-REFERENCED APPLICATIONS

The current application hereby incorporates by reference the material in the following patent applications:

U.S. patent Application No. 60/354,738, entitled “J2EE COMPONENT EXTENSION ARCHITECTURE,” filed Feb. 6, 2002; and

U.S. Patent Application No. 60/397,916, entitled “SYSTEM AND METHOD FOR IMPLEMENTING J2EE CONNECTOR ARCHITECTURE,” filed Jul. 23, 2002.

COPYRIGHT NOTICE

A portion of the disclosure of this patent document contains material which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document or the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.

FIELD OF THE INVENTION

The current invention relates generally to connector architectures, and more particularly to detecting connection leaks in a J2EE connector architecture.

BACKGROUND OF THE INVENTION

The Java™ 2 Platform, Enterprise Edition (J2EE), from Sun Microsystems, Inc. of Palo Alto, Calif., defines a standard for developing multi-tier enterprise applications. A J2EE Connector Architecture is useful for the integration of J2EE-compliant application servers with at least one enterprise information system (EIS). There are typically two parts to this architecture: an EIS vendor-provided resource adapter and an application server to which the resource adapter plugs in. The J2EE Connector Architecture also defines a common client interface (CCI) that can be used to access an EIS. A CCI defines a client API for interacting with heterogeneous EIS systems, which enables application components and Enterprise Application Integration (EAI) frameworks to drive interactions across heterogeneous EIS systems using a common client API.

A resource adapter is a segment of code that represents an Enterprise Information System (EIS). More specifically, a resource adaptor is a system-level software driver used by an application server such as WebLogic Server is used to connect to an enterprise information system (EIS). A resource adapter serves as the “J2EE connector.” The connector architecture implementation supports resource adapters developed by EIS vendors and third-party application developers that can be deployed in any application server supporting the Sun Microsystems J2EE Platform Specification, Version 1.3. Resource adapters contain the Java, and if necessary, the native components required to interact with the EIS.

J2EE Connector Architecture is an architecture for integrating J2EE-compliant application servers with enterprise information systems (EIS). There are two parts to this architecture: an EIS vendor-provided resource adapter and an application server, such as WebLogic Server, by BEA Systems of San Jose, Calif., to which the resource adapter plugs in. This architecture defines a set of contracts, such as transactions, security, and connection management, that both the resource adapter and application server need to support to communicate with one another. The J2EE Connector Architecture also defines a Common Client Interface (CCI) for EIS access. The CCI defines a client API for interacting with heterogeneous EIS's.

What is needed is an improved connector architecture implementation system that is more efficient and allows an administrator to monitor and make changes to connections within the application server as needed.

SUMMARY OF THE INVENTION

A connector architecture implementation is provided that includes advantageous features in connection management as well as other areas. In one embodiment of the present invention, connector leaks may be detected both automatically and manually. Connection pools for an EIS may be configured to more efficiently fulfill connection requests. In one embodiment, connection pools are pre-populated when the application server starts up. In another embodiment, connection pools that experience reduced usage are decreased in size. Managed connections may be recycled to fulfill connection requests. In another embodiment, managed connections may be monitored by an administrator. A user may monitor connections such as leaking connections and idle connections and delete connections as needed.

BRIEF DESCRIPTION OF THE DRAWINGS

FIG. 1 is an illustration of a connector architecture in accordance with one embodiment of the present invention.

FIG. 2 is an illustration of a method for automatically detecting a connection leak in accordance with one embodiment of the present invention.

FIG. 3 is an illustration of a method for manually detecting a connection leak in accordance with one embodiment of the present invention.

FIG. 4 is an illustration of a method for configuring a connection pool in accordance with one embodiment of the present invention.

FIG. 5 is an illustration of a method for controlling connection pool shrinkage in accordance with one embodiment of the present invention.

FIG. 6 is an illustration of a method for monitoring connections in accordance with one embodiment of the present invention.

FIG. 7 is an illustration of a method for storing credentials in accordance with one embodiment of the present invention.

DETAILED DESCRIPTION

A connector architecture implementation is provided that is J2EE compliant and provides improved connection management capabilities. In one embodiment of the present invention, the connector architecture implementation provides a connector leak detection mechanism. The connector leak detector may detect connection leaks both automatically and manually. In another embodiment of the present invention, the connector architecture implementation is operable to pre-configure a connection pool and manage the growth and reduction of a connection pool. The connector architecture implementation may be pre-configured by pre-populating the connection pool. Connection pool growth may be managed by connections that are created in response to connection requests. A connection pool in the present invention may also be configured to reduce the number of connections in the pool. In one embodiment, the number of connections is reduced if the connection demand decreases. Password credentials allowing access to services are used to provide additional connection management.

FIG. 1 is an illustration of a connector architecture implementation 100 in accordance with one embodiment of the present invention. Connector architecture implementation 100 includes application server 110, resource adapter 120, enterprise information system (EIS) 130, and application component 140. In one embodiment of the present invention, the connector architecture implementation is compatible with J2EE. The connector architecture implementation may be implemented in an application server and an EIS-specific resource adapter.

A resource adapter is a system level software driver used by an application server to connect to an EIS. A resource adapter may serve as a connector. Resource adapters contain the Java and any native components required for the application server to interact with the EIS. In one embodiment, the connector architecture of the present invention supports resource adapters developed by EIS vendors and third party application developers that can be deployed in any application server supporting the J2EE platform specification. An EIS provides the information infrastructure for an enterprise and offers a set of services to its clients. The services may be exposed to clients as local or remote interfaces, or both. An application component may be an EJB, JSP, or servlet that is deployed, managed, or executed on an application server.

The connector architecture implementation 100 of FIG. 1 further includes system level contracts. System level contracts exist between the resource adapter and the application server. The contracts may relate to connection management or other aspects of the connector architecture. Connection management contracts allow an application server the ability to provide a pool of connections to underlying EISs that enable application components to connect to an EIS. In one embodiment of the present invention, the connection management relates to connection pool configuration, connection pool management, and connection management.

In connector systems, multiple applications may attempt to establish a connection with the EIS. One connection pool holds all available managed connections to this EIS. Sometimes, after connecting to and using the services of an EIS, connector applications may not close the connection object. A connection object that is not closed after the application has completed using the connection object is considered a leaking connection.

In one embodiment of the present invention, leak detection is performed automatically by leveraging the garbage collector. FIG. 2 illustrates a method 200 for detecting connection leaks automatically. Method 200 begins with start step 210. Next, an application component terminates in step 220. Once an application component terminates, the connection object used by the application component becomes de-referenced. After the application component terminates, the garbage collector calls a connection object in step 230. In one embodiment, the “finalize( )” method of a connection object is called by the garbage collector. Operation then continues to step 240. In one embodiment, the connector architecture implementation then determines if the application component closed the connection object at step 240. If the application component was determined to have closed the connection, or if the application server determines it is not safe to close the connection object, (for example, another application has a reference to the connection object), the method proceeds to end step 260. If the application component did not close the connection object and the application server confirms that it is safe, then the connection object is closed in step 250. In one embodiment, the server automatically closes the connection object in step 250. The server may close the connection object by calling the resource adapter's “ManagedConnection.cleanup( )” method. The application server then operates as it would have if it received a “ConnectionClosed” event upon a proper closure of the application component connection. After closing the connection object in step 250, the method ends in step 260.

In some instances, a leak detection system in addition to the automatic leak detection system is desirable. For example, the garbage collector may not call the finalize( ) method of the connection object used by the faulty application component. In this situation, additional leak detection methods would be useful for establishing increased connection management efficiency.

The connector architecture implementation of the present invention also provides for a manual leak detection mechanism. The manual leak detection mechanism may be advantageous in detecting leaks when the garbage collector is unreliable and in the case of multiple connection object references. A method 300 for manual leak detection performed within the connector architecture of the present invention is shown in FIG. 3. Method 300 begins with start step 310. Next, in step 320 the connector architecture implementation determines whether the application component is actively using the connection it has requested. An active connection is a connection wherein an application component is currently using a requested connection object by calling methods on it or calling a request for a connection object request. If the application component connection is determined to be active, then operation returns to step 320. If an application component connection is determined to be inactive, operation continues to step 330. In step 330, a mechanism is triggered to monitor the time an application component connection is inactive. In one embodiment, the mechanism is a timer. The timer measures the last time a particular connection was active. In one embodiment, a timer may be configured to transpire in seconds for each connection associated with an EIS. In step 340, if an inactive connection becomes active while the timer transpires, operation continues to step 320. While the connection remains inactive, operation continues to step 350 and the timer continues to transpire. In step 360, it is determined whether or not the timer has reached a particular value. In one embodiment, the particular value is configured as a maximum idle time parameter. The maximum idle time parameter is a period of time in which after it has elapsed, the connection is considered expired. If the value of the timer is less then the maximum idle time parameter in step 360, operation continues to step 340. If the value of the timer has reached the maximum idle time parameter, then operation continues to step 370. In step 370, the connector architecture implementation determines if there is a demand for a managed connection. In one embodiment, a demand for a managed connection exists if the connection pool has reached a maximum capacity of managed connections and the connector architecture implementation receives a managed connection request. If either no connection request has been made or a connection request has been made but the connection pool may fulfill the request, then operation regarding the particular connection object request continues to step 340. If the connection pool has no available allocated connections and a connection request is made, operation continues to step 380. In step 380, the connector architecture implementation closes the connection object associated with the timer that has exceeded the maximum idle time parameter. The managed connection is now available to service connection requests. Operation of the manual leak detection system then ends in step 390.

In addition to detecting connection leaks, the connector architecture implementation of the present invention may configure a connection pool for an EIS to aid in fulfilling connection requests. In one embodiment, the connection pool can be configured for pre-population. Pre-populating the connection pool with an initial number of managed connections is done upon startup of the application server and connector architecture implementation of the present invention. This pre-population prevents experiencing a decrease in performance when the managed connections are later created upon request. FIG. 4 illustrates a method 400 for configuring a connection pool in accordance with one embodiment of the present invention. Method 400 begins with start step 405. Next, the connector architecture implementation of the present invention determines whether or not an EIS is configured in such a manner as to pre-populate the connection pool associated with the EIS with an initial number of managed connections. If the connection pool is not to be pre-populated, then operation continues to step 430. If pre-population is to occur, then operation continues to step 420. In step 420, the connection pool is populated with managed connections. In one embodiment, the number of managed connections used to pre-populate a connection pool may be configured by a pre-population parameter. The parameter is specific to a particular connection pool associated with the resource adapter. In one embodiment of the present invention, the pre-population parameter is an initial-capacity element, located in an XML formatted descriptor file of the connector architecture implementation of the present invention. The initial capacity element specifies how many managed connections a connection pool should be pre-populated with at the deployment of a resource adapter with the application server. In one embodiment of the present invention, pre-population of managed connections may not be done where runtime parameters are required.

A connection increment parameter is then configured in step 430. The connection increment parameter represents the number of managed connections that are created at the time a connection request is made. The connection increment parameter allows a user to control the connection pool growth and when to incur the performance and processing costs of connection pool growth. In one embodiment, the connection increment parameter is a capacity-increment element located in an XML formatted descriptor file of the connector architecture implementation of the present invention.

A connection request is then received in step 440. In one embodiment, a connection request may involve an application component requesting a connection object to an EIS through the resource adapter. Once a connection request is received, the connector architecture implementation determines whether the request may be fulfilled with existing available managed connections in step 450. If the connection request can be fulfilled, then operation continues to step 480. If the connection request can not be fulfilled with existing and available managed connections, the operation continues to step 460.

In step 460, it is determined whether creating a new managed connection will exceed a maximum allowed number of managed connections. In one embodiment, the maximum number of allowed connections is determined by a maximum-capacity element located in an XML formatted descriptor file of the connector architecture implementation of the present invention. The maximum number of managed connections may be configured for a single EIS. In one embodiment, more than one managed connection may be created when a connection request is received and no available managed connections exist. In particular, the number of managed connections created may correspond to the capacity-increment parameter. Thus, if the connection increment parameter has a value of three, then the connector architecture implementation will attempt to add three managed connections if a connection request can not be fulfilled by existing and available managed connections. In any case, if adding managed connections in the amount of the connection increment parameter does not bring the number of managed connections associated with an EIS over the maximum managed connections allowed for that EIS, then operation continues to step 465 where the new managed connections are created within the connection pool. If adding the new managed connections does bring the number of managed connections over the maximum allowed for an EIS, then operation continues to step 470.

The connection architecture implementation determines whether or not managed connections can be recycled in step 470. In one embodiment, recycling includes terminating connection objects that are determined to be inactive. The connector architecture implementation may determine a connection object is inactive according to the method 300 for manually detecting connection leaks as illustrated in FIG. 3 and discussed above. In particular, in step 370, if it is determined that the timer associated with a connection has transpired and a connection request is received in step 370, then the connection object will be closed in step 380 and recycled for use in step 470. If no connection objects exist that can be recycled, then operation continues to step 475 where a warning is logged and the connection request fails. If existing connection objects may be recycled to meet the connection request, the connection request is fulfilled in step 480. Operation then ends in step 495.

In addition to managing the growth of a connection pool, the connector architecture implementation of the present invention can manage the reduction of the connection pool. In one embodiment of the present invention, the connector architecture implementation may monitor the managed connection usage and reduce the size of the connection pool if the usage has decreased. A method 500 for reducing the number of managed connections in accordance with one embodiment of the present invention is illustrated in FIG. 5. Method 500 begins with start step 510. Next, the connector architecture implementation of the present invention determines whether managed connection usage has decreased in step 520. If the managed connection usage has decreased through the use of fewer managed connections or in some other manner, then operation continues to step 530. If the managed connection usage has not decreased, then operation returns to step 520. In step 530, the connector architecture implementation determines if the managed connection usage decrease has existed for a specified period of time. In one embodiment of the present invention, the period of time may be configured as a parameter in the shrink-period-minutes element located in an XML formatted descriptor file of the connector architecture implementation. The period of time is associated with a single connection pool associated with the resource adapter. If the usage decrease has not existed for the specified period of time, then operation returns to step 520. If the usage decrease has existed for the specified period of time, operation continues to step 540. The size of the connection pool is decreased in step 540. In one embodiment, at least one managed connection is closed to reduce the size of the connection pool. The connector architecture implementation may close a number of managed connections to establish a number of managed connections to efficiently satisfy ongoing connection requests In one embodiment, connection object usage is monitored by taking “snapshots” of connection object usage at intervals of time, the snapshots triggered by a monitor timer. When shrinking is detected as a result of a comparison of the snapshots, or if the connector architecture determines shrinking should occur, the connection pool is reduced to the higher of the initial-capacity of the pool or the average usage level. In one embodiment, the method for reduction of the connection pool may be enabled or disabled by the user. In one embodiment, reduction of the connection pool may be enabled by configuring a shrinking-enabled element located in an XML formatted descriptor file of the connector architecture implementation.

The connector architecture implementation may also provide for monitoring of managed connections. In one embodiment of the present invention, a user may view and monitor managed connections. Types of managed connections to view and monitor may include leaked and idle connections. In one embodiment of the present invention, a connection-profiling-enabled element located in an XML formatted descriptor file of the connector architecture implementation indicates whether a connection pool should store the call stacks of where each connection is allocated. In one embodiment, if the connection-profiling-enabled element is configured to be true, the stacks for leaked, and idle connections can be viewed and a user may debug components that fail to close connection objects. A method 600 for monitoring of connections in accordance with one embodiment of the present invention is illustrated in FIG. 6. Method 600 begins with start step 610. Next, a user may choose between viewing information regarding and monitoring leaked connections and idle connections. If leaked connections are to be viewed, then operation continues to step 630. In step 630, a user may view information regarding leaked connections. The leaked connection information may be displayed through a console, a log window, or some other manner. The leaked connection information may include run time information of leaked connections, profile information. In one embodiment, profile information displayed includes dates from the call stack of the connection object usage. This data helps the administrator determine which application or application component caused the leak. If idle connections are to be viewed, then operation continues to step 640. In step 640, idle information such as profile information for idle connections may be viewed by a user. After viewing connection information in steps 630 or 640, a user may then decide to delete a connection object in step 650. In one embodiment, a leaked connection object may be deleted if the connection object has exceeded a specified idle time and is not involved in a transaction. If no connection is to be deleted, then operation continues to step 670. If a connection object is to be deleted, then operation continues to step 660 where the connection object is deleted. Next, operation continues to step 670 where a user may view more connections or end the monitoring of managed connections. If a user wishes to further monitor managed connections, operation continues to step 620. If no further monitoring of managed connections is to occur, operation ends at step 680.

The connector architecture implementation provides security management. In one embodiment of the present invention, credentials are stored in a javax.securtiy.auth.Subject object to comply with Sun's J2EE Connector Specification, version 1.0 final release. A method 700 for storing credentials in accordance with one embodiment of the present invention is shown in FIG. 7. Method 700 begins with start step 710. Next, an EIS resource object is instantiated in step 710. In one embodiment, a weblogic.security.Service.EISResource object is instantiated with the following command:

new EISResource(java.lang.String applicationName, java.lang.String moduleName, java.lang.String eisName)

The command is executed from the security management code of the WebLogic Server. Next, the initiating principal for the connection request is obtained in step 730. In one embodiment, the initiating principal is obtained by querying the WebLogic Server security code for the user initiated principal associated with the application component making the connection request. Then, credentials for the initiating principal are obtained in step 740. In one embodiment, the credentials are obtained with the following command:

weblogic.security.Service.PrincipalAuthenticator(String initiatingPrincipal,weblogic.security.Service.Resource eisResource)

A Subject file is then instantiated in step 750. In one embodiment, the file is a javax.security.auth.Subject. Then, credentials are added to the subject file in step 760. In one embodiment, the credentials are added to the private set in the credentials with the following command:

Subject.getPrivateCredentials( ).add(Credential)

The Subject file is then completed and method 700 ends at step 770.

The connector architecture implementation of the present invention is provided that is J2EE compliant and provides improved connection management capabilities. In one embodiment of the present invention, the connector architecture implementation provides a connector leak detection mechanism. The connector leak detector may detect connection leaks both automatically and manually. In another embodiment of the present invention, the connector architecture implementation is operable to pre-configure a connection pool and manage the growth and reduction of a connection pool. The connector architecture may be pre-configured by pre-populating the connection pool. Connection pool growth may be managed by connections that are created in response to connection requests. A connection pool in the present invention may also be configured to reduce the number of connections in the pool. In one embodiment, the number of connections is reduced if the connection demand decreases. Password credentials allowing access to services are used to provide additional connection management.

In addition to an embodiment consisting of specifically designed integrated circuits or other electronics, the present invention may be conveniently implemented using a conventional general purpose or a specialized digital computer or microprocessor programmed according to the teachings of the present disclosure, as will be apparent to those skilled in the computer art.

Appropriate software coding can readily be prepared by skilled programmers based on the teachings of the present disclosure, as will be apparent to those skilled in the software art. The invention may also be implemented by the preparation of application specific integrated circuits or by interconnecting an appropriate network of conventional component circuits, as will be readily apparent to those skilled in the art.

The present invention includes a computer program product which is a storage medium (media) having instructions stored thereon/in which can be used to program a computer to perform any of the processes of the present invention. The storage medium can include, but is not limited to, any type of disk including floppy disks, optical discs, DVD, CD-ROMs, microdrive, and magneto-optical disks, ROMs, RAMs, EPROMs, EEPROMs, DRAMs, VRAMs, flash memory devices, magnetic or optical cards, nanosystems (including molecular memory ICs), or any type of media or device suitable for storing instructions and/or data.

Stored on any one of the computer readable medium (media), the present invention includes software for controlling both the hardware of the general purpose/specialized computer or microprocessor, and for enabling the computer or microprocessor to interact with a human user or other mechanism utilizing the results of the present invention. Such software may include, but is not limited to, device drivers, operating systems, and user applications. Ultimately, such computer readable media further includes software for performing the methods of the present invention.

Included in the programming (software) of the general/specialized computer or microprocessor are software modules for implementing the teachings of the present invention, including, but not limited to, separating planes of a source image, averaging at least one of foreground and background colors, replacing colors, and compensating for error introduced by color replacement in one plane by feeding error into a second plane, storage, communication of results, and reconstructing an image according to the processes of the present invention.

Other features, aspects and objects of the invention can be obtained from a review of the figures and the claims. It is to be understood that other embodiments of the invention can be developed and fall within the spirit and scope of the invention and claims.

The foregoing description of embodiments of the present invention has been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Obviously, many modifications and variations will be apparent to the practitioner skilled in the art. The embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention for various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the following claims and their equivalents. 

1. A method of automatically detecting a connection leak in a connector architecture implementation comprising: terminating an application component, the application component forming a connection with an enterprise information system; calling a connection object; determining if the connection used by an application component is closed; and closing the connection.
 2. The method of claim 1 wherein calling a connection object includes a garbage collector calling the connection object.
 3. The method of claim 2 wherein calling a connection object includes the garbage collector calling a method of the connection object.
 4. The method of claim 1 wherein closing the connection includes an application server automatically closing the connection.
 5. The method of claim 4 wherein closing the connection includes the application server calling a method from the resource adapter.
 6. A method of manually detecting a connection leak in a connector architecture implementation comprising: determining that an application component is inactive and not actively using a connection between the application component and an enterprise information system; receiving a connection request; and determining whether the application component has been inactive for a first time period before said receiving a connection request.
 7. The method of claim 6 further comprising: closing the connection if the application component has been inactive for a first time period before said receiving a connection request.
 8. The method of claim 6 wherein determining whether the application component has been inactive for a certain time period includes providing a timer, the timer configured to start when the application component is determined to be inactive.
 9. A computer-readable storage medium, storing instructions for automatically detecting a connection leak in a connector architecture implementation, the instructions comprising: terminating an application component, the application component forming a connection with an enterprise information system; calling a connection object; determining if the connection used by an application component is closed; and closing the connection.
 10. The computer-readable storage medium of claim 9 wherein calling a connection object includes a garbage collector calling the connection object.
 11. The computer-readable storage medium of claim 10 wherein calling a connection object includes the garbage collector calling a method of the connection object.
 12. The computer-readable storage medium of claim 9 wherein closing the connection includes an application server automatically closing the connection.
 13. The computer-readable storage medium of claim 12 wherein closing the connection includes the application server calling a method from the resource adapter.
 14. A computer-readable storage medium of manually detecting a connection leak in a connector architecture implementation comprising: determining that an application component is inactive and not actively using a connection between the application component and an enterprise information system; receiving a connection request; and determining whether the application component has been inactive for a first time period before said receiving a connection request.
 15. The computer-readable storage medium of claim 14 further comprising: closing the connection if the application component has been inactive for a first time period before said receiving a connection request.
 16. The computer-readable storage medium of claim 14 wherein determining whether the application component has been inactive for a certain time period includes providing a timer, the timer configured to start when the application component is determined to be inactive. 